home *** CD-ROM | disk | FTP | other *** search
/ Aminet 21 / Aminet 21 (1997)(GTI - Schatztruhe)[!][Oct 1997].iso / Aminet / comm / net / NGConfig.lha / NGConfig.doc < prev    next >
Text File  |  1997-07-15  |  8KB  |  195 lines
  1.  
  2.               **************************************************
  3.  
  4.                                  NGConfig 1.1
  5.  
  6.                      Configuration editor for NetGate 1.3a
  7.                  The Internet<=>Fidonet News and Mail Gateway
  8.  
  9.                NGConfig written by Uffe Holst, uhc@post6.tele.dk
  10.                          Midkemia Software Development
  11.                          Copyright 1997 by Uffe Holst
  12.                               All Rights Reserved
  13.  
  14.                             NGConfig is E-mailWare
  15.  
  16.               **************************************************
  17.  
  18.  
  19. DESCRIPTION
  20. -----------
  21.  
  22. NGConfig  is a configuration editor for NetGate. NetGate by Michael Berg is the
  23. best Internet <-> FidoNet News and Mail Gateway available for the Amiga.
  24.  
  25.  
  26. FEATURES
  27. --------
  28.  
  29. NGConfig features include:
  30.  
  31.  * Easy-to-use configuration GUI using gtlayout.library by Olaf 'Olsen' Barthel
  32.  
  33.  * AmigaGuide context sensitive online help, asynchronous
  34.  
  35.  * Support for all NetGate 1.3 configuration keywords
  36.  
  37.  * Fully localized - yet no localizations available
  38.  
  39.  * That's all... it's after all only a configuration editor
  40.  
  41.  
  42. INTRODUCTION
  43. ------------
  44.  
  45. This  document  should probably describe the usage of NGConfig but it doesn't -
  46. therefore   please   refer   to  the  NetGate.guide  accompanying  the  NetGate
  47. distribution. The actual usage of NGConfig is quite simple.
  48.  
  49. NGConfig  was  actually never intended to become a true program. I were looking
  50. for  a  GUI library as a replacement for Triton and when I came across GTLayout
  51. by Olaf 'Olsen' Barthel I decided to test the library by making a configuration
  52. editor  GUI  for  NetGate  since  this  would be a quite complex GUI. Therefore
  53. NGConfig is actually only an exercise in GTLayout programming :-)
  54.  
  55. When  the  GUI  was  finished I needed some data to test the GUI handling, so I
  56. started parsing a few commands in the NetGate configuration file to obtain some
  57. data.  When  I  had  gone  this  far  it was no major task to make the GTLayout
  58. exercise into a full featured configuration editor for NetGate. I have missed a
  59. configuration editor for NetGate and I suppose other have missed one too.
  60.  
  61.  
  62. REQUIREMENTS
  63. ------------
  64.  
  65. NGConfig  requires Workbench 2.04+ and gtlayout.library. The latter is included
  66. in the NGConfig distribution.
  67.  
  68. reqtools.library  is  used for file and directory requsters but is not included
  69. in the distribution.
  70.  
  71.  
  72. INSTALLATION and USAGE
  73. ----------------------
  74.  
  75. Copy  the  NGConfig  executable  (and  maybe  this  text  file) to your NetGate
  76. directory.  Either  copy  the  gtlayout.library  to  the  same  diretory as the
  77. NGConfig executable or copy it to your libs: directory.
  78.  
  79. Invoke  NGConfig  by typing its name on the command line (i.e. in your shell) -
  80. currently  NGConfig features no icon. NGConfig reads your NetGate configuration
  81. file  (NOTICE: NGConfig will only read the file called 'NetGate.config' located
  82. in  the  same  directory  as  NGConfig  itself) and an optional file containing
  83. inactive  newsgroups  -  this file is named 'NetGate.inactive' and must also be
  84. located in the same directory as NGConfig itself.
  85.  
  86. The  NGConfig  editor contains several pages. Move through these pages and make
  87. your choices.
  88.  
  89. NGConfig  features  context sensitive online help. To use this feature you must
  90. have  the  NetGate.guide  file  located  in  the same directory as the NGConfig
  91. executable.  Just hit the 'Help' key and NGConfig will invoke the NetGate.guide
  92. file  with  the  relevant  configuration  keyword displayed. I saw no reason to
  93. write  my  own  documentation  since  everything  is  fully  described  in  the
  94. NetGate.guide.  A few gadgets haven't not got a link in the NetGate.guide file,
  95. and  several  gadgets  have got the same link - the 'subwindows' have no online
  96. help, sorry about that. The NetGate.guide is opened asynchronously so you don't
  97. have to close it between invocations.
  98.  
  99. When  you  have finished, you exit the editor by closing the window. Regardless
  100. of  changes  having  been  made  or  not  NGConfig  will prompt you to 'Save or
  101. discard changes?' any possible changes. The old NetGate configuration file will
  102. be   renamed   to   NetGate.config.backup   (and   do   remember   that  a  old
  103. NetGate.config.backup  file  will  be  deleted,  so  you  can  only  restore  a
  104. configuration  one  step  (i.e.  one  save) backwards). The same applies to the
  105. 'NetGate.inactive' file being written if you make some newsgroups inactive.
  106.  
  107.  
  108. LOCALIZATIONS
  109. -------------
  110.  
  111. NGConfig  is  fully  localized. If you like to localize NGConfig (less than 150
  112. text  strings) to your language please e-mail me (uhc@post6.tele.dk) and I will
  113. send you the catalog description file.
  114.  
  115. Currently only the builtin English language is supported.
  116.  
  117.  
  118. FLAWS
  119. -----
  120.  
  121. · NGConfig  only  reads  a configuration file named 'NetGate.config' located in
  122.   the    same    directory    as   NGConfig   itself,   i.e.   NGConfig   reads
  123.   'PROGDIR:NetGate.config'.  I  attempted  to implement the same search path as
  124.   NetGate  uses,  but  for  some  unknown  reason NGConfig kept crashing - so I
  125.   removed it again.
  126.  
  127. · I  normally disable/enable newsgroups by placing an semicolon in front of the
  128.   newsgroup  I  want  to disable making the line a comment. Since NGConfig uses
  129.   ReadArgs()  to parse the configuration file all such comments will be skipped
  130.   and  will NOT be written to the configuration file when saved. I hope Michael
  131.   Berg  in a future release of NetGate implement an INACTIVE/ACTIVE keyword for
  132.   the NEWSGROUP command.
  133.  
  134.   To  bypass  this  you  can  still  make  newsgroups  inactive or active using
  135.   NGConfig,   but   inactive  newsgroups  will  be  written  to  an  additional
  136.   'NetGate.inactive'   file   which   NGConfig  also  scans  when  loading  the
  137.   configuration file.
  138.  
  139.  
  140. ACKNOWLEDGEMENT
  141. ---------------
  142.  
  143. I send my thanks to the following persons
  144.  
  145. · Michael Berg for NetGate - the program missing a configuration editor
  146. · Olaf 'Olsen' Barthel for the gtlayout.library
  147. · Preben Nielsen for the link library SortList for sorting Exec lists
  148. · Magnus Holmgren/Nico François for the reqtools.library
  149.  
  150. · Anders Wegge Jakobsen, Nils Bandener and Mark Ritter
  151.  
  152. · Kent B. Hansen for some betatesting
  153.  
  154.  
  155. SHAREWARE/AUTHOR
  156. ----------------
  157.  
  158. NGConfig  is ShareWare. Although it is ShareWare I will not charge you anything
  159. for  using  the  program  - NGConfig is a too simple program although it can be
  160. quite usable. Therefore it should rather be called E-mailWare.
  161.  
  162. Therefore  please  send me an e-mail if you use and/or like NGConfig. If nobody
  163. uses  NGConfig  I see no reason to release a new version if a future version of
  164. NetGate becomes new configuration keywords - or bugs are found in this version.
  165. This  version  is  only  released because I think others can benefit from it as
  166. well as myself.
  167.  
  168. So  to become a registered user send me an e-mail and tell me if you don't want
  169. to  be  listed in the list of registered user below. If you do not specifically
  170. ask  to  be  removed  from the list you will find yourself listed with the next
  171. NGConfig release.
  172.  
  173. Naturally  I  will accept any kind of donations you would like to make - money,
  174. music  CDs,  girls  (e.g.  your  sister), Coca-Cola etc. If you want to give me
  175. something please don't hesitate to e-mail me.
  176.  
  177. My e-mail address is uhc@post6.tele.dk
  178.  
  179.  
  180. LIST OF REGISTERED USERS
  181. ------------------------
  182.  
  183.   1. Uffe Holst
  184.   2. Kent B. Hansen
  185.  
  186.  
  187. HISTORY
  188. -------
  189.  
  190. 1.0  First public release
  191.  
  192. 1.1  Bug release
  193.      - the configuration command NOSCANNEWGROUPS was misspelled preventing
  194.        NGConfig from reading the configuration file.
  195.